执行研发阶段流水线_云效(Apsara Devops)-阿里云帮助中心

通过 OpenAPI 执行研发阶段流水线。

适用版本

标准版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID 。
产品
资源
所需权限
应用交付
研发阶段
读写

请求语法

POST https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/releaseWorkflows/{releaseWorkflowSn}/releaseStages/{releaseStageSn}:execute

请求参数

参数	类型	位置	是否必填	描述	示例值
appName	string	path	是	应用名。	my-web-service
releaseWorkflowSn	string	path	是	发布流程唯一序列号。	app-release-sn-xxx
releaseStageSn	string	path	是	发布流程阶段唯一序列号。	app-release-stage-sn-xxx
organizationId	string	path	是	组织 ID。	99d1****71d4
-	object	body	否	执行流水线请求。
params	map	body	否	运行流水线参数，支持指定运行备注、代码源分支、自定义参数。详见示例。	{ "params": { "FLOW_INST_RUNNING_COMMENT": "运行备注", "my_source_1": "master", "k1": "v1" } } 说明： - FLOW_INST_RUNNING_COMMENT：用于指定运行备注 - my_source_1：流水线源id（1. 使用GUI创建的流水线，流水线源id对应研发流程流水线编辑时代码源首次添加时的目录；2. 使用yaml创建的流水线，流水线源id参考文档流水线源 sources ） - master： my_source_1 代码源使用的分支 - k1：流水线变量名称 - v1：k1对应的变量值

请求示例

curl -X 'POST' \
  'https://test.rdc.aliyuncs.com/oapi/v1/appstack/organizations/organization-id-xxx/apps/my-web-service/releaseWorkflows/app-release-sn-xxx/releaseStages/app-release-stage-sn-xxx:execute' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "params": {
          "FLOW_INST_RUNNING_COMMENT": "运行备注",
          "my_source_1": "master",
          "k1": "v1"
        }
    }'

返回参数

参数	类型	描述	示例值
-	object	执行流水线阶段结果。
object	number	流水线运行 id，也即流水线的运行次数。	1
pipelineId	number	流水线 ID。	123
pipelineRunId	number	流水线运行 id，也即流水线的运行次数。	1

返回示例

{
    "object": 1,
    "pipelineId": 123,
    "pipelineRunId": 1
}

错误码

访问错误码中心查看 API 相关错误码。

产品	资源	所需权限
应用交付	研发阶段	读写